pp108 : GetObjectsByFolder (Deprecated)

GetObjectsByFolder (Deprecated)

This method is used to retrieve all the objects that are in a particular folder. You can also retrieve objects that belong to shared folders. GetObjectsByFolder is part of the CoBOC Methodset 4.2 in the Cordys CoBOC application package.

SOAP Request

<GetObjectsByFolder xmlns="http://schemas.cordys.com/1.0/coboc">
    <cursor numRows="2"/>
    <folder_name>/Vendor</folder_name>
    <folder_id>117117382112910</folder_id>
    <version>organization</version>
</GetObjectsByFolder>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

cursor

Number of rows that would be returned by the query

Integer

The numRows attribute of this element determines the number of rows that would be returned by the query.

folder_name

Name of the folder

String

To retrieve a shared folder, prefix the name of the folder with shared/.

folder_id

ID of the folder

String

version

Contains the version of the type of content

String

The supported versions are:

  • user
  • organization
  • isv
    If you do not provide the version, the system first searches in the user space, followed by the organization space, and then in the isv space.

SOAP Response

<GetObjectsByFolderResponse xmlns="http://schemas.cordys.com/1.0/coboc">
    <cursor numRows="2"/>
    <tuple>
        <old>
            <data>
                <metadata>
                    <object_id>11720266794461</object_id>
                    <folder_id>117117382112910</folder_id>
                    <objectname>Prod_obj1</objectname>
                    <key>/Vendor/Prod_obj1</key>
                    <organization>o=system,cn=cordys,o=vanenburg.com</organization>
                    <owner>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</owner>
                    <description/>
                    <customkey>33615803</customkey>
                    <history>0</history>
                    <event>0</event>
                    <template_id>11745312963608</template_id>
                    <lastmodifieddate>1173097363566</lastmodifieddate>
                </metadata>
                <object/>
            </data>
        </old>
    </tuple>
    <tuple>
        <old>
            <data>
                <metadata>
                    <object_id>11743262485815</object_id>
                    <folder_id>117117382112910</folder_id>
                    <objectname>Prod_Obj2</objectname>
                    <key>/Vendor/Prod_Obj2</key>
                    <organization>o=system,cn=cordys,o=vanenburg.com</organization>
                    <owner>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</owner>
                    <description/>
                    <customkey>33670675</customkey>
                    <history>0</history>
                    <event>0</event>
                    <template_id>11745312963608</template_id>
                    <lastmodifieddate>1173097345899</lastmodifieddate>
                </metadata>
                <object/>
            </data>
        </old>
    </tuple>
</GetObjectsByFolderResponse>

Response Parameters

Parameter

Description

old

Indicates that the object contained in the request exists in the database.

object_id

Unique ID identifying the object.

folder_id

Unique ID identifying the folder.

objectname

Name of the object.

key

Name of the object along with the full path.

organization

Organization in which the object has been inserted.

owner

User who instantiated the object.

description

Description of the object.

customkey

Custom key of the object. Defined on an attribute of a template, the custom key prevents replication of the object and maintains object uniqueness.

history

Indicates whether the object is being monitored.

event

Information about events defined on the object. Events help track changes in the state of the object.

template_id

Unique ID identifying the template.

lastmodifieddate

Indicates the last date and time of modification of the object.

object

Inserted object enclosed within this element.